Resource URL: /platform/<<version=3>>/cluster/nodes/<LNN>/drives/<DRIVEID>/format

    Overview: This resource allows the user to format drives in a node in a
              OneFS cluster

     Methods: POST

********************************************************************************

Method POST: Format a drive for use by OneFS.

        URL: POST
             /platform/<<version=3>>/cluster/nodes/<LNN>/drives/<DRIVEID>/format

There are no query arguments for this method.

POST request body schema:
{
  "type": "object", 
  "description": "Drive purpose information.", 
  "properties": {
    "purpose": {
      "required": false, 
      "type": "string", 
      "description": "The purpose to which this drive should be formatted. If not specified, defaults to 'None', which will be automatically purposed based on node configuration and drive type."
    }
  }
}

POST response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": [
        "null", 
        "object"
      ], 
      "description": "Null or any empty JSON object.", 
      "properties": {}
    }
  ]
}
